New Database Trigger Options #611

MongoCaleb · 2023-10-16T18:43:09Z

Pull Request Info

Jira

https://jira.mongodb.org/browse/DOCSP-33588

Staged Changes

https://preview-mongodbmongocaleb.gatsbyjs.io/atlas-app-services/DOCSP-33588/triggers/database-triggers/#std-label-trigger-recursion

nathantfrank · 2023-10-16T18:53:40Z

source/triggers/database-triggers.txt

+           Trigger is associated with.
+
+       - :guilabel:`Database Name`. The MongoDB database that contains the watched
+         collection. Optional if the :guilabel:`Collection Name` is specified.


Suggested change

collection. Optional if the :guilabel:`Collection Name` is specified.

collection. Required if the :guilabel:`Collection Name` is specified.

Maybe we should add some copy about how a Deployment trigger is when database and collection are not specified. Database trigger is when collection is not specified, and Collection Trigger when both are specified.

@nathantfrank does this mean that even if the user selects the Collection or Database source type, it will actually be a Deployment type if they leave both database and collection blank?

Ahhh Sorry I misunderstood what this section was doing.
My current thought is we should just remove that sentence.

Suggested change

collection. Optional if the :guilabel:`Collection Name` is specified.

collection.

nathantfrank · 2023-10-16T19:29:47Z

source/triggers/database-triggers.txt


-       .. tip:: Performance Optimization
+       - :guilabel:`Operation Type`. The :ref:`database operation types 


[Q] should this be database?

@nathantfrank Sorry, not sure what you're asking here.

Ahhh, I think I'm confusing myself with existing documentation details. I was thinking this should be like collection operation types and link to something different.

nathantfrank · 2023-10-16T19:31:07Z

source/triggers/database-triggers.txt

+         - Drop Database
+         - Create Collection
+         - Modify Collection
+         - Rename Collection
+         - Shard Collection
+         - Drop Collection


Only Drop Database is a deployment only operation type. All the rest of these are database operation types.

[Q] Also do we want to add this list to each of them (COLLECTION, DATABASE, DEPLOYMENT)?

… into DOCSP-33588

nathantfrank · 2023-10-17T16:32:48Z

source/triggers/database-triggers.txt

+         - Create Collection
+         - Modify Collection
+         - Rename Collection
+         - Shard Collection
+         - Drop Collection


As mentioned in our chat, these are actually Database+ change event types.

nathantfrank

Also just talked to Product about this recent change. Deployment level will not be supported if the cluster being watched is a shared tier. Not exactly sure where we want to add this in the docs.

nathantfrank · 2023-10-17T18:53:04Z

source/triggers/database-triggers.txt

+         - Create Document
+         - Modify Document
+         - Rename Document
+         - Shard Document
+         - Drop Document


This should be Insert, Update, Replace, and Delete

nathantfrank · 2023-10-17T18:53:37Z

source/triggers/database-triggers.txt

+         - Create Collection
+         - Modify Collection
+         - Rename Collection
+         - Shard Collection
+         - Drop Collection


Missing the 2 new sharding types

MongoCaleb · 2023-10-18T16:39:24Z

@nathantfrank : WRT your comment about Deployment only being supported on non-shared tiers, what happens in the UI? Is that box just diabled? What happens if I choose, say, Collection, and then leave Collection Name and DB Name blank (which should force Deploy level)? Thanks!

nathantfrank · 2023-10-18T16:46:46Z

WRT your comment about Deployment only being supported on non-shared tiers, what happens in the UI? Is that box just diabled?

Images taken from local branch, not yet merged. So it will be disabled. If they select Deployment and then select a shared tier we will move them automatically to Database level.

What happens if I choose, say, Collection, and then leave Collection Name and DB Name blank (which should force Deploy level)?

If they try to save as described above we have added validation on the backend to respond with: deployment changestreams are not supported on shared tier clusters. This is the suspended trigger error the customer will also receive if they managed to get a deployment trigger with a shared tier cluster (somehow bypassing validation) on their app.

nathantfrank

All most there from my perspective just 2 questions.

[Q] Use Match Expressions to Limit Trigger Invocations only lists the document change event types, do we want to include links for the others?

nathantfrank · 2023-10-18T18:01:23Z

source/triggers/database-triggers.txt

+       - :guilabel:`Operation Type`. The :ref:`database operation types 
+         <database-event-operation-types>` that cause the Trigger to fire. 


[Q] Only this Database row has a link, do we want to have a link for Collection and Deployment as well?

… into DOCSP-33588

nathantfrank

Are we able to time the release or is once this is merged it is live in the documentation?

nathantfrank · 2023-10-18T20:22:15Z

source/triggers/database-triggers.txt

+.. warning::
+
+   It is possible to configure triggers that cause other triggers to fire on the 
+   same collection, database, or cluster, resulting in recursion. Examples 
+   include a database trigger writing to a collection within the same 
+   database, or a cluster-level logger writing database logs to another database 
+   in the same cluster.
+


I think we may want to explicitly call out log forwarders as well here. Since, they are a first class resource that our users may also be using that could cause this issue.

Isn't that just a specific case of a process writing to a monitored database and/or collection?

You are correct, but just wanted to make customer's slightly more conscious if they didn't make that connection.

Talked offline in the project channel with team and Laura, we would like to go with.

Suggested change

.. warning::

It is possible to configure triggers that cause other triggers to fire on the

same collection, database, or cluster, resulting in recursion. Examples

include a database trigger writing to a collection within the same

database, or a cluster-level logger writing database logs to another database

in the same cluster.

.. warning::

In deployment and database level triggers, it is possible to configure triggers

in a way that causes other triggers to fire, thereby resulting in recursion.

Examples include a database-level trigger writing to a collection within the

same database, or a cluster-level logger or log forwarder writing logs to

another database in the same cluster.

@MongoCaleb Could we get an update on this since it should be going in tomorrow.

MongoCaleb · 2023-10-18T20:30:51Z

@nathantfrank we can delay deployment. When is the anticipated release?

nathantfrank · 2023-10-18T20:33:03Z

@nathantfrank we can delay deployment. When is the anticipated release?

We are targeting the week after skunkworks, so likely around Nov 1st would be ideal.

nathantfrank

1 Q/potential change, then looks good to me when that is addressed.

nathantfrank · 2023-11-01T21:27:44Z

source/triggers/database-triggers.txt

     - Represents a new document that replaced a document in the collection.

+   * - **Create_Collection** (Database and Deployment trigger types only)


[Q] Any particular reason we are underscoring here and below?

docs-builder-bot · 2023-11-01T21:41:15Z

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/atlas-app-services/master/

🪵 Logs

job log: 37b3d5d15e292c1600f7657c1c90308a00e9cf92

MongoCaleb added 7 commits October 16, 2023 10:08

testing table formatting

c3fdc3b

sanity check

584d75f

add recursion warning and fix formatting of table

fe5d96b

more formatting fun

e3c565a

tabs, spaces, indents, oh my

985f758

more formatting...

7654e99

change messaging and hopefully fix the table formatting

f194b81

nathantfrank reviewed Oct 16, 2023

View reviewed changes

MongoCaleb added 4 commits October 16, 2023 12:48

review 1

c1de63f

add new operations and mark db and collection names as optional

ac536fc

add to config reference

b4a1d27

change database->collection

80dc42a

MongoCaleb requested a review from nathantfrank October 16, 2023 20:17

MongoCaleb added 2 commits October 16, 2023 13:20

review change & fix column width

29969a3

make more clear which operations for which trigger types

90edce6

MongoCaleb requested review from nlarew and removed request for nathantfrank October 16, 2023 20:38

clean up note and fix indentation

54b8333

MongoCaleb requested a review from nathantfrank October 16, 2023 20:57

MongoCaleb and others added 5 commits October 16, 2023 13:57

Merge branch 'master' into DOCSP-33588

4e1d7b5

Merge branch 'master' into DOCSP-33588

21dea41

testing removal of warnings that act like errors

02f7a1b

Merge branch 'DOCSP-33588' of github.com:MongoCaleb/docs-app-services…

124e590

… into DOCSP-33588

final formatting fix

545c72a

nathantfrank reviewed Oct 17, 2023

View reviewed changes

MongoCaleb added 3 commits October 17, 2023 09:54

changes after discussion

4961239

differentiate deployment types for change events

254fb2b

remove note and make inline

aa52585

MongoCaleb mentioned this pull request Oct 17, 2023

add new operations and mark db and collection names as optional #612

Closed

3 tasks

nathantfrank suggested changes Oct 17, 2023

View reviewed changes

MongoCaleb and others added 2 commits October 18, 2023 10:36

add note about dedicated tiers; fix lists

b76041b

Merge branch 'master' into DOCSP-33588

449a077

MongoCaleb requested a review from nathantfrank October 18, 2023 17:47

nathantfrank reviewed Oct 18, 2023

View reviewed changes

MongoCaleb added 2 commits October 18, 2023 12:53

add missing opertation types

740c26d

Merge branch 'DOCSP-33588' of github.com:MongoCaleb/docs-app-services…

6d519eb

… into DOCSP-33588

MongoCaleb requested a review from nathantfrank October 18, 2023 19:54

nathantfrank suggested changes Oct 18, 2023

View reviewed changes

MongoCaleb added the DO NOT MERGE Pending feature release, review, or discussion label Oct 18, 2023

nlarew approved these changes Oct 19, 2023

View reviewed changes

MongoCaleb and others added 7 commits November 1, 2023 13:46

merge

e6653e0

Merge branch 'master' into DOCSP-33588

eecdaf4

merge

239d746

re-incorping pre-image ticket and fixing table headings

a0b53cc

clarifying note about disabled

00b7d91

merge

e7fcc05

remove extra header

a04195e

nathantfrank suggested changes Nov 1, 2023

View reviewed changes

remove _

4366c18

nathantfrank approved these changes Nov 1, 2023

View reviewed changes

MongoCaleb merged commit 37b3d5d into mongodb:master Nov 1, 2023
4 checks passed

MongoCaleb deleted the DOCSP-33588 branch November 1, 2023 21:39

MongoCaleb added a commit to MongoCaleb/docs-app-services that referenced this pull request Jun 3, 2024

New Database Trigger Options (mongodb#611)

d856b26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Database Trigger Options #611

New Database Trigger Options #611

MongoCaleb commented Oct 16, 2023

nathantfrank Oct 16, 2023

MongoCaleb Oct 16, 2023

nathantfrank Oct 16, 2023

nathantfrank Oct 16, 2023

MongoCaleb Oct 16, 2023

nathantfrank Oct 16, 2023

nathantfrank Oct 16, 2023

nathantfrank Oct 17, 2023

nathantfrank left a comment

nathantfrank Oct 17, 2023

MongoCaleb Oct 18, 2023

nathantfrank Oct 17, 2023

MongoCaleb commented Oct 18, 2023

nathantfrank commented Oct 18, 2023

nathantfrank left a comment

nathantfrank Oct 18, 2023

nathantfrank left a comment

nathantfrank Oct 18, 2023

MongoCaleb Oct 18, 2023

nathantfrank Oct 18, 2023

nathantfrank Oct 20, 2023

nathantfrank Oct 31, 2023

MongoCaleb commented Oct 18, 2023

nathantfrank commented Oct 18, 2023

nathantfrank left a comment

nathantfrank Nov 1, 2023 •

edited

Loading

docs-builder-bot commented Nov 1, 2023

	collection. Optional if the :guilabel:`Collection Name` is specified.
	collection. Required if the :guilabel:`Collection Name` is specified.

	collection. Optional if the :guilabel:`Collection Name` is specified.
	collection.


		.. tip:: Performance Optimization
		- :guilabel:`Operation Type`. The :ref:`database operation types

		- :guilabel:`Operation Type`. The :ref:`database operation types
		<database-event-operation-types>` that cause the Trigger to fire.

		- Represents a new document that replaced a document in the collection.

		* - Create_Collection (Database and Deployment trigger types only)

New Database Trigger Options #611

New Database Trigger Options #611

Conversation

MongoCaleb commented Oct 16, 2023

Pull Request Info

Jira

Staged Changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nathantfrank left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MongoCaleb commented Oct 18, 2023

nathantfrank commented Oct 18, 2023

nathantfrank left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nathantfrank left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MongoCaleb commented Oct 18, 2023

nathantfrank commented Oct 18, 2023

nathantfrank left a comment

Choose a reason for hiding this comment

nathantfrank Nov 1, 2023 • edited Loading

Choose a reason for hiding this comment

docs-builder-bot commented Nov 1, 2023

🪵 Logs

nathantfrank Nov 1, 2023 •

edited

Loading